IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/librw/RWTPtrHashMapIterator.z/RWTPtrHashMapIterator

Text File | 2002-10-03 | 8.2 KB | 199 lines

RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                        RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



NNNNaaaammmmeeee
     RWTPtrHashMapIterator<K,T,H,EQ> - Rogue Wave library class

SSSSyyyynnnnooooppppssssiiiissss
              #include<rw/tphdict.h>



              RWTPtrHashMap<K,T,H,EQ> m;
          RWTPtrHashMap<K,T,H,EQ> itr(m);






PPPPlllleeeeaaaasssseeee NNNNooootttteeee!!!!
     IIIIffff yyyyoooouuuu hhhhaaaavvvveeee tttthhhheeee SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ddddeeeessssccccrrrriiiibbbbeeeedddd hhhheeeerrrreeee....
     OOOOtttthhhheeeerrrrwwwwiiiisssseeee,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ffffoooorrrr RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr described
     in Appendix A.


DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
     RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr is supplied with TTTToooooooollllssss....hhhh++++++++ 7.x to provide an
     iterator interface to the Standard Library based collections that has
     backward compatibility with the container iterators provided in TTTToooooooollllssss....hhhh++++++++
     6.x. Iteration over an RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaapppp is pseudorandom and dependent on the
     capacity of the underlying hash table and the hash function being used.
     The current item referenced by this iterator is undefined after
     construction or after a call to rrrreeeesssseeeetttt(((()))).  The iterator becomes valid
     after being advanced with either a preincrement or ooooppppeeeerrrraaaattttoooorrrr(((()))).  For both
     ooooppppeeeerrrraaaattttoooorrrr++++++++ and ooooppppeeeerrrraaaattttoooorrrr(((()))), iterating past the last element will return a
     value equivalent to boolean ffffaaaallllsssseeee.  Once this state is reached, continued
     increments will return a value equivalent to ffffaaaallllsssseeee until rrrreeeesssseeeetttt(((()))) is
     called.

PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
     None

EEEExxxxaaaammmmpppplllleeeessss
              #include<rw/tphdict.h>



              #include<iostream.h>
          #include<rw/cstring.h>
          struct silly_h{
             unsigned long operator()(RWCString x) const
               { return x.length() * (long)x(0); }
          };
          int main(){
             RWTPtrHashMap



                                                                        PPPPaaaaggggeeee 1111






RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                        RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



               <RWCString,int,silly_h,equal_to<RWCString> > age;
             RWTPtrHashMapIterator
               <RWCString,int,silly_h,equal_to<RWCString> > itr(age);
             age.insert(new RWCString("John"),new int(30));
             age.insert(new RWCString("Steve"),new int(17));
             age.insert(new RWCString("Mark"),new int(24));
          //Duplicate insertion is rejected
             age.insert(new RWCString("Steve"),new int(24));
             for(;++itr;)
               cout << *itr.key() << "'s age is " << *itr.value() << endl;
             return 0;
          }
          Program Output (not necessarily in this order)
          John's age is 30
          Mark's age is 24

PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
     Steve's age is 17



              RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr<<<<KKKK,,,,TTTT,,,,HHHH,,,,EEEEQQQQ>>>>(RWTPtrHashMap<K,T,H,EQ>&h);


     Creates an iterator for the hashed map hhhh.  The iterator begins in an
     undefined state and must be advanced before the first element will be
     accessible.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss
              K*
          ooooppppeeeerrrraaaattttoooorrrr(((())))();


     Advances self to the next element, dereferences the resulting iterator
     and returns its key.  If the iterator has advanced past the last item in
     the container,  the element returned will be a nnnniiiillll pointer equivalent to
     boolean ffffaaaallllsssseeee.

              RWBoolean
          ooooppppeeeerrrraaaattttoooorrrr++++++++();


     Advances self to the next element.  If the iterator has been reset or
     just created self will now reference the first element.  If, before
     iteration, self referenced the last association in the multi-map, self
     will now reference an undefined value and a value equivalent to ffffaaaallllsssseeee
     will be returned.  Otherwise, a value equivalent to ttttrrrruuuueeee is returned.
     Note: no post-increment operator is provided.







                                                                        PPPPaaaaggggeeee 2222






RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                        RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



Public Member Functions
              RWTPtrHashMap<K,T,H,EQ>*
          ccccoooonnnnttttaaaaiiiinnnneeeerrrr(((()))) const;


     Returns a pointer to the collection being iterated over.

              K*
          kkkkeeeeyyyy() const;


     Returns the key portion of the association currently referenced by self.
     Undefined if self is not referencing a value within the map.

              void
          rrrreeeesssseeeetttt();
          void
          rrrreeeesssseeeetttt(RWTPtrHashMap<K,T,H,EQ>& h);


     Resets the iterator so that after being advanced it will reference the
     first element of the collection.  Using rrrreeeesssseeeetttt(((()))) with no argument will
     reset the iterator on the current container.  Supplying a hashed map with
     rrrreeeesssseeeetttt(((()))) will reset the iterator on that container.

              T*
          vvvvaaaalllluuuueeee();


     Returns the value portion of the association pointed to by self.  The
     behavior is undefined if the map is empty.
























                                                                        PPPPaaaaggggeeee 3333